home *** CD-ROM | disk | FTP | other *** search
/ How to Get Online 1996 Spring / HOW2GON.ISO / mac / HTML / HTML Markup 1.0 / Readme < prev    next >
Encoding:
Text File  |  1995-07-31  |  7.7 KB  |  181 lines  |  [TEXT/R*ch]
  1. HTML Markup 1.0
  2. ©1995, by Scott J. Kleper
  3.  
  4. Released on 8-1-95
  5. ---------------------------
  6.  
  7. HTML Markup is a drag-and-drop Macintosh text->html converter. There are many
  8. programs that seem to accomplish similar tasks. However, HTML Markup takes a
  9. slightly different approach to the conversion.
  10.  
  11. When you drag a file or files onto the HTML Markup icon, you are presented with
  12. a "job ticket" that allows you to check off your conversion options. The 
  13. options available are:
  14.  
  15. •Use first line as <TITLE>
  16.     This option will take the first line of your text file and make it the
  17.     title of the HTML document. If you do not use this option, your HTML file
  18.     will have no title. In the final version, there will be additional options
  19.     like using the file name for the title. Note that if you use this option,
  20.     the first line of your file will still remain in the HTML format and will
  21.     also be the title.
  22.  
  23. •Use first line as <H1>
  24.     This option will take the first line of your text file and make it an <H1>
  25.     header for the file. The line will not be repeated and this option may 
  26.     be used with the above option.
  27.  
  28. •Center <H1>
  29.     This option is only used with the above option. It centers the <H1> 
  30.     described above. If the above option is not used, this option is 
  31.     ignored.
  32.  
  33. •Break lines with <BR>
  34.     This option will terminate every line with the <BR> flag. Personally,
  35.     I would almost never do this. One of the reasons I wrote HTML Markup
  36.     was because the converter that I used to use would do this and it
  37.     pissed me off. Still, I can see why some people would want to terminate
  38.     every line so I made it an option. If you are converting something like
  39.     C source code to HTML, it can be useful. Without it, everything would
  40.     run together.
  41.  
  42. •Change lists to <UL>'s (modified in 1.0ß5, modified again in 1.0)
  43.     When a line begins with a • (bullet) or - (dash) character, Markup will
  44.     make it into an item in an HTML <UL> list. If there are zero or one blank 
  45.     lines between individual items, they will be in the same list. If there are
  46.     two or more blank lines separating them, they will be made into separate
  47.     lists. Versions 1.0ß4 and later of HTML Markup contain a new "smart list" 
  48.     algorithm that attempts to identify lists from dashes and bullets used 
  49.     in words. Versions 1.0ß5 and later of HTML Markup allow 2-level nested
  50.     lists. Lists indented with a tab are made into second-level lists. For
  51.     example, if this readme document were converted with this option, each
  52.     item (the bulleted features) would be a list item. The following list
  53.     would be a 2nd level list:
  54.     -item one
  55.     -item two
  56.     -item three
  57.  
  58. •Change # lines to <OL>'s (new in 1.0ß5, modified in 1.0)
  59.     When a line begins with a # (pound sign), Markup will make it into an item
  60.     in a <OL> list. <OL> lists are numbered lists. So if you had several items
  61.     listed in a text file, putting a # before each of them would enumerate them
  62.     when viewed with an HTML viewer.
  63.  
  64. •Convert lines to <hr> (new in 1.0ß4)
  65.     Markup looks for a series of two or more dashes and changes them into an 
  66.     <hr> line.
  67.  
  68. •Convert URLs to href's (new in 1.0ß5, modified in 1.0)
  69.     This feature is darn cool. Markup will scan your source file for ftp, 
  70.     telnet, http, or gopher URLs. With this option selected, they will 
  71.     automatically be converted into clickable links in the HTML output.
  72.     For example, if I included the HTML Markup web support page in this
  73.     document: http://htc.rit.edu/klephacks/markup.html and selected this
  74.     option, it would automatically be converted into a link to the page
  75.     in the HTML output. HTML Markup assumes that the last character in the URL 
  76.     is followed by a tab, space, > sign, or carriage return. The protocol
  77.     portion of the URL (ftp, telnet, http, or gopher) must be lower case
  78.     to be understood by HTML Markup.
  79.  
  80. •Keep inline flags (new in 1.0ß4)
  81.     Markup keeps anything contained within < and > characters in the new
  82.     file. In this way, you can write text files with embedded HTML and use
  83.     HTML Markup to add in the mundane stuff like the <HTML> and <BODY> flags.
  84.  
  85. •Show final summary
  86.     With this option selected, HTML Markup will tell you, before quitting,
  87.     precisely what it has done. It will tell you how many files have been
  88.     processed, the number of text to HTML conversions made, the number of
  89.     <UL> and <OL> lists made, the number of <HR> lines made, the total 
  90.     number of kilobytes processed (rounded), and a daily lucky number 
  91.     (actually, it's always sixteen).
  92.  
  93. •Create index.html (new in 1.0ß5)
  94.     With this option selected, HTML Markup will create a file with links
  95.     to all the HTML files it creates. In this way, you can have a file
  96.     to use to test all your pages. You can modify it to be a real index
  97.     (you'd want to spice it up a bit) or use it for archival purposes.
  98.     Or you could use it as a replacement for the lousy indexes that usually
  99.     show up if there's no index.html file (just about anything is better
  100.     than that!) There are a few limitations. The links are only to the
  101.     file names, so they must be in the same directory as the index.html
  102.     file and there is a ten kilobyte limit to this file. When that size
  103.     is reached, Markup will stop writing the index file but will continue
  104.     to process documents.
  105.  
  106. •Output ticket (new in 1.0ß4, modified in 1.0ß5)
  107.     A new button and dialog control the output options for the html file. 
  108.     The following options control how the resulting files are output on your
  109.     drive:
  110.     -Same name as original file
  111.     -Add .html to the end of the file name
  112.     -Prompt me for a new file name
  113.     -File creator code (modified in 1.0)
  114.     -Convert spaces in file names to underscores (new in 1.0ß5)
  115.     -Convert file names to lower case (new in 1.0ß5)
  116.  
  117. •Header/Footer Ticket (new in 1.0ß5, REGISTERED USERS ONLY!)
  118.     This button brings up the Header/Footer Ticket which allows you to
  119.     select text documents to append to the beginning or end of the <BODY>
  120.     portion of your HTML document. This is useful if you have a company
  121.     logo or link that you want on every page. You can include HTML 
  122.     within the header and footer files. They are copied verbatim
  123.     into the resulting HTML files.
  124.  
  125. •Color Ticket (new in 1.0ß5, modified in 1.0, REGISTERED USERS ONLY!)
  126.     This button brings up the new color ticket. Popup menus for
  127.     background, text, links, and visited links select the colors
  128.     for your document. Selecting "default" will set no value, and
  129.     the browser will use its default color. 
  130.  
  131. •Comment Ticket (new in 1.0ß5, REGISTERED USERS ONLY!)
  132.     This button brings up a dialog box where you can write a 
  133.     comment line to be put at the beginning of every file. This
  134.     line will appear in the source for the document, but will
  135.     not be displayed by the browser. This is useful if you wish
  136.     to attach a copyright or credit line to all your pages.
  137.     The line must be 255 or fewer characters long.
  138.  
  139. •Shareware line supression (REGISTERED USERS ONLY!)
  140.     If you are a registered user of HTML Markup, the shareware
  141.     message containing a link to the Markup home page will not 
  142.     be displayed. If you have not paid for your copy of Markup,
  143.     a brief message will let people know that you have used
  144.     HTML Markup to convert this document and will give them a 
  145.     link to find out more about it.
  146.  
  147.  
  148.  
  149. Please send me your comments and ideas! There will be more version of 
  150. HTML Markup in the future and I need your feedback! HTML Markup would
  151. not be the powerful utility that it is without the feedback and help
  152. of beta users.
  153.  
  154. Registered versions of HTML Markup are ready and really extend the power
  155. of the program. Single user licenses are only $15 and include a disk with
  156. the registered version. Contact me for information on site licenses.
  157. To register your copy, send your check for $15 to:
  158.  
  159. Scott J. Kleper
  160. 134 Caversham Woods
  161. Pittsford, NY  14534
  162.  
  163.  
  164. Questions? Comments? Bugs? Ideas? Send email to:
  165.  
  166. sjked@rit.edu
  167.  
  168. The WWW support page for HTML Markup is:
  169.  
  170. http://htc.rit.edu/klephacks/markup.html
  171.  
  172. The FTP site is:
  173.  
  174. ftp://htc.rit.edu/pub/
  175.  
  176. Enjoy!
  177.  
  178. --------
  179. Scott J. Kleper
  180. 8/1/95
  181.